Skip to main content

Request reference

When the the AtScale system receives a HTTP request for the data catalog API, it returns a response in XML format. The response contains the requested details and their schema.

Response message​

The response is a SOAP message in the following format:

<?xml version="1.0"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <as:queryId xmlns:as="http://xsd.atscale.com/soap_v1" soap:mustUnderstand="0">d40c923a-1c05-4607-98eb-e18bcf38c838</as:queryId>
  </soap:Header>
  <soap:Body>
    <ExecuteResponse xmlns="urn:schemas-microsoft-com:xml-analysis">
      <return>
        <root xmlns="urn:schemas-microsoft-com:xml-analysis:rowset" xmlns:msxmla="http://schemas.microsoft.com/analysisservices/2003/xmla" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
          <xsd:schema xmlns:sql="urn:schemas-microsoft-com:xml-sql" targetNamespace="urn:schemas-microsoft-com:xml-analysis:rowset" elementFormDefault="qualified">
          </xsd:schema>
          <row>
          </row>
        </root>
      </return>
    </ExecuteResponse>
  </soap:Body>
</soap:Envelope>

It contains the <xsd:schema> element, and also a <row> element for each entry that matches the request query.

Schema​

The <xsd:schema> element provides definition of the elements containing the data you need - <row> and its children.

Row​

When the AtScale system finds entries that match the request query, it includes a <row> element for each entry found. A <row> element contains one or more children. The child elements have the same names as the parameters included in the query. The syntax is a follows:

<row>
  <PARAMETER>VALUE</PARAMETER>
</row>

Response example​

The documentation for the data catalog API provides many sample responses. Here is an example containing data for the name and description parameters of dimensions:

<?xml version="1.0"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <as:queryId xmlns:as="http://xsd.atscale.com/soap_v1" soap:mustUnderstand="0">d40c923a-1c05-4607-98eb-e18bcf38c838</as:queryId>
  </soap:Header>
  <soap:Body>
    <ExecuteResponse xmlns="urn:schemas-microsoft-com:xml-analysis">
      <return>
        <root xmlns="urn:schemas-microsoft-com:xml-analysis:rowset" xmlns:msxmla="http://schemas.microsoft.com/analysisservices/2003/xmla" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
          <xsd:schema xmlns:sql="urn:schemas-microsoft-com:xml-sql" targetNamespace="urn:schemas-microsoft-com:xml-analysis:rowset" elementFormDefault="qualified">
            <xsd:element name="root">
              <xsd:complexType>
                <xsd:sequence minOccurs="0" maxOccurs="unbounded">
                  <xsd:element name="row" type="row"/>
                </xsd:sequence>
              </xsd:complexType>
            </xsd:element>
            <xsd:simpleType name="uuid">
              <xsd:restriction base="xsd:string">
                <xsd:pattern value="[0-9a-zA-Z]{8}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{12}"/>
              </xsd:restriction>
            </xsd:simpleType>
            <xsd:complexType name="xmlDocument">
              <xsd:sequence>
                <xsd:any/>
              </xsd:sequence>
            </xsd:complexType>
            <xsd:complexType name="row">
              <xsd:sequence>
                <xsd:element sql:field="DIMENSION_NAME" name="DIMENSION_NAME" type="xsd:string" minOccurs="0"/>
                <xsd:element sql:field="DESCRIPTION" name="DESCRIPTION" type="xsd:string" minOccurs="0"/>
              </xsd:sequence>
            </xsd:complexType>
          </xsd:schema>
          <row>
            <DIMENSION_NAME>Customer Dimension</DIMENSION_NAME>
            <DESCRIPTION>Customer Key</DESCRIPTION>
          </row>
          <row>
            <DIMENSION_NAME>Order Date Dimension</DIMENSION_NAME>
            <DESCRIPTION>Date Dimension that includes Gregorian, ISO8601 and Retail 445 calendars</DESCRIPTION>
          </row>
          <row>
            <DIMENSION_NAME>Product Dimension</DIMENSION_NAME>
            <DESCRIPTION>Product Line, Category, and Name</DESCRIPTION>
          </row>
        </root>
      </return>
    </ExecuteResponse>
  </soap:Body>
</soap:Envelope>

More information​

Request reference: How to make requests to the Data Catalog API.